Renames a file, directory, or volume.

OSErr PBHRenameSync (
    HParmBlkPtr paramBlock
);

paramBlock

A pointer to a basic HFS parameter block.

function result

A result code.

DISCUSSION

The relevant fields of the parameter block are:

• ioCompletion

  On input, a pointer to a completion function.

• ioResult

  On output, the result code of the function.

• ioNamePtr

  On input, a pointer to a name for the file, volume, or directory whose name you wish to change.

• ioVRefNum

  On input, a volume specification. Given a pointer to a volume name in ioNamePtr or a volume reference number in ioVRefNum, the function changes the name of the volume.

• ioMisc

  On input, a pointer to the new name for the file, directory or volume..

• ioDirID

  On input, a directory ID.

If a file ID reference exists for the file being renamed, the file ID remains with the file.

SPECIAL CONSIDERATIONS

You cannot use PBHRenameSync to change the directory in which a file is located.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)